d払い(都度決済) API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranDocomo 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
JobCd	jobCd	必須処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字6桁利用金額
Tax	tax	半角数字6桁税送料税送料を指定した場合は、利用金額＋税送料が決済金額となります。

URL

/payment/EntryTranDocomo.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "100"
}

URL

/payment/EntryTranDocomo.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=100

レスポンス

正常

AccessID		accessID		半角英数32桁固定取引ID
AccessPass		accessPass		半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranDocomo 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
DocomoDisp1	docomoDisp1	全半角40バイトドコモ表示項目1
DocomoDisp2	docomoDisp2	全半角40バイトドコモ表示項目2
RetURL	retURL	必須半角英数記号256桁決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。 d払い画面上でお客様が認証、支払操作をキャンセルした場合や、当サービスにて決済処理を実行した場合に指定されたURLに結果がリダイレクト経由で送信されます。
PaymentTermSec	paymentTermSec	半角数字5桁支払開始期限秒お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。最大86,400秒（1日）呼び出しパラメータが空の場合、120秒で処理されます。
DispCompanyName	dispCompanyName	全半角32バイト会社名
DispShopName	dispShopName	全半角32バイト利用店舗名
DispPhoneNumber	dispPhoneNumber	半角数字記号13桁連絡先電話番号
DispMailAddress	dispMailAddress	半角英数記号96桁メールアドレス
DispShopUrl	dispShopUrl	半角英数記号96桁問い合わせURL
DocomoCompanyCode	docomoCompanyCode	半角英数20桁企業コード
DocomoShopCode	docomoShopCode	半角英数20桁店舗コード

※ 直接契約加盟店様は、DispCompanyName～DispShopUrlの指定は不要です。

※ DispPhoneNumber～DispShopUrlの設定値の合計バイト数を96バイト以内にしてください。

URL

/payment/ExecTranDocomo.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "retURL": "https://example.com/receive"
}

URL

/payment/ExecTranDocomo.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive

レスポンス

正常

AccessID	accessID	半角英数32桁固定取引ID
Token	token	半角英数記号256桁固定トークン取引IDのハッシュ値を返却します。
StartURL	startURL	半角英数記号256桁支払手続き開始IFのURL 支払手続き開始IFのURLを返却します。
StartLimitDate	startLimitDate	半角数字14桁固定支払開始期限日時支払手続き開始IFの呼び出し期限を返却します。 yyyyMMddHHmmss書式

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
  "startURL": "https://x01.mul-pay.jp/payment/DocomoStart.idPass",
  "startLimitDate": "20190225162711"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/DocomoStart.idPass&StartLimitDate=20190225162711

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

DocomoStart 支払手続き開始IFの呼び出し

お客様をd払い画面へ誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト

AccessID		必須半角英数32桁固定取引ID
Token		必須半角英数256桁固定トークン

URL

/payment/DocomoStart.idPass

リクエストパラメータ

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL

リダイレクトページサンプル


<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="DocomoStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          d払いの決済画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script>
    <!--
      function OnLoadEvent() {
        document.DocomoStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

決済結果受信

NTTドコモ社から、当サービスに認証・支払操作結果が通知されます。
認証・支払操作結果は、お客様が支払操作を完了した場合と認証・支払操作をキャンセルした場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。
この決済結果は、d払いの決済完了画面からブラウザ経由で連携されるため、ユーザの操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。その際はショップ管理画面または結果通知にて確認ください。
また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID		必須半角英数13桁ショップID
OrderID		必須半角英数記号27桁オーダーID
Status		必須現状態該当取引の取引状態を返却します。 AUTHPROCESS：認証中 AUTH：仮売上 CAPTURE：即時売上 PAYFAIL：決済失敗
TranDate		必須半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。 yyyyMMddHHmmss書式
DocomoSettlementCode		必須半角数字12桁ドコモ決済番号

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

DocomoCancelReturn 決済キャンセル・返品

決済が完了した取引に対して決済内容のキャンセル・返品を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
CancelAmount	cancelAmount	必須半角数字6桁キャンセル金額
CancelTax	cancelTax	半角数字6桁キャンセル税送料キャンセル金額＋キャンセル税送料をキャンセル金額とします。（1円以上）例）請求525円より全額キャンセルする場合：キャンセル金額には525を設定します請求525円より210円分キャンセルする場合：キャンセル金額には210を設定します

URL

/payment/DocomoCancelReturn.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "100"
}

URL

/payment/DocomoCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=100

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID
Status	status	現状態キャンセル・返品成功時は以下のステータスが返却されます。・CANCEL：キャンセル
Amount	amount	半角数字6桁利用金額利用金額からキャンセル金額を減算した結果を返却します。例）利用金額500円よりキャンセル金額300円 => 利用金額200円
Tax	tax	半角数字6桁税送料税送料からキャンセル税送料を減算した結果を返却します。例）税送料250円よりキャンセル税送料150円 => 税送料100円
CancelAmount	cancelAmount	半角数字6桁キャンセル金額キャンセル金額を返却します。
CancelTax	cancelTax	半角数字6桁キャンセル税送料キャンセル税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "CANCEL",
  "amount": "0",
  "tax": "0",
  "cancelAmount": "100",
  "cancelTax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=100&CancelTax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

DocomoSales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト

ShopID	shopID	必須半角数字13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字6桁利用金額
Tax	tax	半角数字6桁税送料利用金額＋税送料が売上金額となります（1円以上） ※合計が0円の場合はエラーとします。 ※オーソリ時より大きい金額の場合はエラーとします。 ※オーソリ時と異なる金額の場合は、指定された金額で売上を確定します。

URL

/payment/DocomoSales.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "100"
}

URL

/payment/DocomoSales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID
Status	status	現状態実売上成功時は以下のステータスが返却されます。・SALES：実売上実売上失敗時は実売上処理前のステータスが返却されます。
Amount	amount	半角数字6桁利用金額実売上した利用金額を返却します。
Tax	tax	半角数字6桁税送料実売上したを税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES",
  "amount": "100",
  "tax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=100&Tax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

DocomoIncrease 増額

決済が完了した取引に対して決済内容の増額を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
IncreaseAmount	increaseAmount	必須半角数字6桁増加金額
IncreaseTax	increaseTax	半角数字6桁増加税送料増加金額＋増加税送料を増加金額とします。（1円以上）

URL

/payment/DocomoIncrease.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "increaseAmount": "100"
}

URL

/payment/DocomoIncrease.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&IncreaseAmount=100

レスポンス

正常

OrderID	orderID	半角数字記号27桁オーダーID
Status	status	現状態増額成功時は以下のステータスが返却されます。・SALES：実売上・CAPTURE：即時売上
Amount	amount	半角数字6桁利用金額利用金額から増加金額を加算した結果を返却します。
Tax	tax	半角数字6桁税送料税送料から増加税送料を加算した結果を返却します。
IncreaseAmount	increaseAmount	半角数字6桁増加金額増加金額を返却します。
IncreaseTax	increaseTax	半角数字6桁増加税送料増加税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES",
  "amount": "200",
  "tax": "0",
  "increaseAmount": "100",
  "increaseTax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=200&Tax=0&IncreaseAmount=100&IncreaseTax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeDocomo/SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
PayType	payType	半角数字2桁決済方法 SearchTradeMultiをご利用の際は「9」を指定してください。 SearchTradeDocomoをご利用の際は設定不要です。

URL

/payment/SearchTradeDocomo.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001"
}

URL：SearchTradeDocomoの場合

/payment/SearchTradeDocomo.idPass

URL：SearchTradeMultiの場合

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001

レスポンス

正常

Status	status	現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証処理中 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 PAYFAIL：決済失敗 EXPIRED：期限切れ CANCEL：キャンセル
ProcessDate	processDate	半角数字14桁固定処理日時処理を実施した日時を返却します。 yyyyMMddHHmmss書式
JobCd	jobCd	処理区分 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル
AccessID	accessID	半角英数32桁固定取引ID
AccessPass	accessPass	半角英数32桁固定取引パスワード
Amount	amount	半角数字10桁利用金額
Tax	tax	半角数字10桁税送料
Currency	currency	半角英字3桁通貨コード空欄を返却します。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
PayType	payType	半角数字2桁決済方法 9：d払い
DocomoSettlementCode	docomoSettlementCode	半角数字12桁ドコモ決済番号
DocomoCancelAmount	docomoCancelAmount	半角数字6桁ドコモキャンセル金額キャンセル・返品した金額を返却します。
DocomoCancelTax	docomoCancelTax	半角数字6桁ドコモキャンセル税送料キャンセル・返品した税送料を返却します。
DocomoIncreaseAmount	docomoIncreaseAmount	半角数字6桁ドコモ増額金額増額した金額を返却します。
DocomoIncreaseTax	docomoIncreaseTax	半角数字6桁ドコモ増額税送料増額した税送料を返却します。
DocomoAcceptCode	docomoAcceptCode	半角英数12桁ドコモ承諾番号都度決済の場合は空欄を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "status": "CAPTURE",
  "processDate": "20190213200436",
  "jobCd": "CAPTURE",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "amount": "1000",
  "tax": "0",
  "currency": "",
  "clientField1": "",
  "clientField2": "",
  "clientField3": "",
  "payType": "9",
  "docomoSettlementCode": "411178431948",
  "docomoCancelAmount": "100",
  "docomoCancelTax": "0"
  "docomoIncreaseAmount": "100",
  "docomoIncreaseTax": "0",
  "docomoAcceptCode": ""
}

レスポンスパラメータ：正常系

Status=CAPTURE&ProcessDate=20190213200436&JobCd=CAPTURE&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&Currency=&ClientField1=&ClientField2=&ClientField3=&PayType=9&DocomoSettlementCode=411178431948&DocomoCancelAmount=100&DocomoCancelTax=0&DocomoIncreaseAmount=100&DocomoIncreaseTax=0&DocomoAcceptCode=

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

d払い